Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ApplyVSchemaDDL: escape Sequence names when writing the VSchema #12519

Merged
merged 1 commit into from
Mar 9, 2023
Merged

ApplyVSchemaDDL: escape Sequence names when writing the VSchema #12519

merged 1 commit into from
Mar 9, 2023

Conversation

hkdsun
Copy link
Member

@hkdsun hkdsun commented Feb 28, 2023

Description

We use ALTER VSCHEMA ... ADD AUTO_INCREMENT ... statements to provision new sharded tables with their Sequence table references, however we ran into a bug because our sequence tables are stored in keyspaces that contain dashes (e.g. `app-name-global`.sequence_table).

The issue is that the ApplyVSchemaDDL function does not escape the value of the Sequence field below even though it's capable of parsing user input correctly:

		table.AutoIncrement = &vschemapb.AutoIncrement{
			Column:   alterVschema.AutoIncSpec.Column.String(),
			Sequence: sequenceFqn,
		}

Not surprising, since we're going through a cycle of parsing user input (from a SQL statment) and then trying to write something out to the VSchema's Table.AutoIncrement.Sequence field with the (new-ish?) understanding that it will be parsed using sqlparser again. As the VSchema docs mention, "If necessary, the reference to the sequence table lookup.user_seq can be escaped using backticks."

We would really love to have this be backported and have a v14.0.5 minor version be released with this fix.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

There should be no functional change in correct existing behaviour. The failing case will be fixed by the changes.

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 28, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 28, 2023 •
edited by systay
Loading

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@hkdsun hkdsun force-pushed the escape-sequences branch 2 times, most recently from 28ede72 to f29d767 Compare February 28, 2023 22:24
@deepthi deepthi removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 1, 2023
@deepthi
Copy link
Member

deepthi commented Mar 6, 2023

@vitessio/query-serving please review

@hkdsun
properly escape sequence table names
6c89766 
Signed-off-by: Hormoz Kheradmand <[email protected]>
@hkdsun hkdsun force-pushed the escape-sequences branch from f29d767 to 6c89766 Compare March 8, 2023 03:18
@hkdsun
Copy link
Member Author

hkdsun commented Mar 8, 2023 •
edited
Loading

I've just rewritten the branch to solve this more elegantly.

One might think "this should have always been written as such" 😄

Could I please get a review? And any word on whether this could be backported? Our team at Shopify would have to otherwise plan a forked release fairly soon.

Thanks everyone

deepthi
deepthi approved these changes Mar 8, 2023
View reviewed changes
Copy link
Member

@deepthi deepthi left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elegant is correct 😄
LGTM, and I think we can backport.
We'll wait to get at least 1 more approval from the query-serving team.

This was referenced Mar 8, 2023
Merged
Closed
systay
systay approved these changes Mar 9, 2023
View reviewed changes
Copy link
Collaborator

@systay systay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice stuff

@systay systay merged commit a24e22c into vitessio:main Mar 9, 2023
This was referenced Mar 9, 2023
Merged
Merged
@vitess-bot vitess-bot bot mentioned this pull request Mar 9, 2023
Merged
jeremycole pushed a commit to Shopify/vitess that referenced this pull request Mar 10, 2023
@hkdsun @jeremycole
properly escape sequence table names (vitessio#12519)
376e7b8 
Signed-off-by: Hormoz Kheradmand <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@systay systay systay approved these changes

@deepthi deepthi deepthi approved these changes

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@rsajwani rsajwani Awaiting requested review from rsajwani

Assignees
No one assigned
Labels
Component: Query Serving Type: Bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hkdsun @deepthi @systay